
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="X-UA-Compatible" content="IE=Edge" />
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>matminer.figrecipes.tests package &#8212; matminer 0.5.4 documentation</title>
    <link rel="stylesheet" href="_static/nature.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
 
<link href='https://fonts.googleapis.com/css?family=Lato:400,700' rel='stylesheet' type='text/css'>

  </head><body>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">matminer 0.5.4 documentation</a> &#187;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="matminer-figrecipes-tests-package">
<h1>matminer.figrecipes.tests package<a class="headerlink" href="#matminer-figrecipes-tests-package" title="Permalink to this headline">¶</a></h1>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline">¶</a></h2>
</div>
<div class="section" id="module-matminer.figrecipes.tests.test_plots">
<span id="matminer-figrecipes-tests-test-plots-module"></span><h2>matminer.figrecipes.tests.test_plots module<a class="headerlink" href="#module-matminer.figrecipes.tests.test_plots" title="Permalink to this headline">¶</a></h2>
<p>PlotlyFig testing. Most tests are run by comparing generated Plotly figures
with pre-generated json files. Some are just ensuring Plotly does not throw
errors.</p>
<dl class="class">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest">
<em class="property">class </em><code class="descclassname">matminer.figrecipes.tests.test_plots.</code><code class="descname">PlotlyFigTest</code><span class="sig-paren">(</span><em>methodName='runTest'</em><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest" title="Permalink to this definition">¶</a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">pymatgen.util.testing.PymatgenTest</span></code></p>
<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.fopen">
<code class="descname">fopen</code><span class="sig-paren">(</span><em>fname</em><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.fopen" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.setUp">
<code class="descname">setUp</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.setUp" title="Permalink to this definition">¶</a></dt>
<dd><p>Hook method for setting up the test fixture before exercising it.</p>
</dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_bar">
<code class="descname">test_bar</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_bar" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_heatmap_basic">
<code class="descname">test_heatmap_basic</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_heatmap_basic" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_heatmap_df">
<code class="descname">test_heatmap_df</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_heatmap_df" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_histogram">
<code class="descname">test_histogram</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_histogram" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_parallel_coordinates">
<code class="descname">test_parallel_coordinates</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_parallel_coordinates" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_scatter_matrix">
<code class="descname">test_scatter_matrix</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_scatter_matrix" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_triangle">
<code class="descname">test_triangle</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_triangle" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_violin">
<code class="descname">test_violin</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_violin" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="method">
<dt id="matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_xy">
<code class="descname">test_xy</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.PlotlyFigTest.test_xy" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

</dd></dl>

<dl class="function">
<dt id="matminer.figrecipes.tests.test_plots.refresh_json">
<code class="descclassname">matminer.figrecipes.tests.test_plots.</code><code class="descname">refresh_json</code><span class="sig-paren">(</span><em>open_plots=False</em><span class="sig-paren">)</span><a class="headerlink" href="#matminer.figrecipes.tests.test_plots.refresh_json" title="Permalink to this definition">¶</a></dt>
<dd><p>For developer use. Refresh the json files and open plots to see if they
look good. Use this function to set the current PlotlyFig build outputs
as the true values of the tests.</p>
<dl class="docutils">
<dt>Args:</dt>
<dd><dl class="first last docutils">
<dt>open_plots (bool): If True, opens all plots generated. Useful if you</dt>
<dd>want to check the current build outputs to make sure they look good.
If False, just generates the json files and quits.</dd>
</dl>
</dd>
</dl>
</dd></dl>

</div>
<div class="section" id="module-matminer.figrecipes.tests">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-matminer.figrecipes.tests" title="Permalink to this headline">¶</a></h2>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
  <h3><a href="index.html">Table of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">matminer.figrecipes.tests package</a><ul>
<li><a class="reference internal" href="#submodules">Submodules</a></li>
<li><a class="reference internal" href="#module-matminer.figrecipes.tests.test_plots">matminer.figrecipes.tests.test_plots module</a></li>
<li><a class="reference internal" href="#module-matminer.figrecipes.tests">Module contents</a></li>
</ul>
</li>
</ul>

  <div role="note" aria-label="source link">
    <h3>This Page</h3>
    <ul class="this-page-menu">
      <li><a href="_sources/matminer.figrecipes.tests.rst.txt"
            rel="nofollow">Show Source</a></li>
    </ul>
   </div>
<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    </div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related" role="navigation" aria-label="related navigation">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="nav-item nav-item-0"><a href="index.html">matminer 0.5.4 documentation</a> &#187;</li> 
      </ul>
    </div>

    <div class="footer" role="contentinfo">
        &#169; Copyright 2015, Anubhav Jain.
      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.8.2.
    </div>

  </body>
</html>